Markdown-Überblick

Was ist Markdown?

Markdown ist eine leichtgewichtige Auszeichnungssprache. Sie schreiben in einem gut lesbaren und einfach zu erstellenden Klartextformat, das sich anschließend in strukturell gültiges HTML umwandeln lässt. Das wichtigste Gestaltungsziel der Markdown-Syntax ist größtmögliche Lesbarkeit.

Grundlegende Syntax

Überschriften

Erstellen Sie Überschriften mit Rautenzeichen (#). Die Anzahl der Rautenzeichen bestimmt die Überschriftenebene: 

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Hervorhebung

Fetter Text mit doppelten Sternchen oder Unterstrichen: 

**Bold text**
__Bold text__

Kursiver Text mit einzelnen Sternchen oder Unterstrichen: 

*Italic text*
_Italic text_

Listen

Ungeordnete Listen mit Sternchen, Pluszeichen oder Bindestrichen: 

* Item 1
* Item 2
* Item 3

+ Item 1
+ Item 2
+ Item 3

- Item 1
- Item 2
- Item 3

Geordnete Listen mit Zahlen, auf die ein Punkt folgt: 

1. First item
2. Second item
3. Third item

Inline-Links mit dem Text in eckigen Klammern und der URL in runden Klammern: 

[Link text](http://example.com)

Referenzlinks mit dem Text und einer Referenz in jeweils eigenen eckigen Klammern: 

[Link text][reference]

[reference]: http://example.com "Optional title"

Automatische Links, indem Sie URLs in spitze Klammern einschließen: 

<http://example.com>
<user@example.com>

Bilder

Bilder verwenden eine ähnliche Syntax wie Links, jedoch mit einem Ausrufezeichen am Anfang: 

![Alt text](http://example.com/image.jpg)
![Alt text][image-reference]

[image-reference]: http://example.com/image.jpg "Optional title"

Blockzitate

Erstellen Sie Blockzitate mit dem Größer-als-Symbol (>) am Anfang jeder Zeile: 

> This is a blockquote.
> It can span multiple lines.
>
> You can have multiple paragraphs in a blockquote.

Code

Inline-Code mit Backticks: 

Use `code` in your text.

Codeblöcke durch Einrücken mit vier Leerzeichen oder einem Tabulator: 

    This is a code block.
    It preserves formatting and spacing.
    Multiple lines are supported.

Horizontale Linien

Erstellen Sie horizontale Linien mit drei oder mehr Bindestrichen, Sternchen oder Unterstrichen: 

---

***

___

Zeilenumbrüche

Harte Zeilenumbrüche erzeugen Sie, indem Sie eine Zeile mit zwei oder mehr Leerzeichen beenden: 

This line ends with two spaces.
This creates a hard line break.

Weiche Zeilenumbrüche erzeugen Sie durch einfaches Drücken der Eingabetaste (daraus wird in HTML ein Leerzeichen): 

This line
continues on the next line with a space.

Escape-Zeichen

Sonderzeichen mit Backslashes maskieren: 

\*This text is not italic\*
\[This is not a link\]

Häufige Zeichen, die maskiert werden können:

  • \ Backslash
  • ` Backtick
  • * Sternchen
  • _ Unterstrich
  • {} geschweifte Klammern
  • [] eckige Klammern
  • () Klammern
  • # Hash
  • + Pluszeichen
  • - Minuszeichen
  • . Punkt
  • ! Ausrufezeichen

Bewährte Vorgehensweisen

  1. Verwenden Sie Leerzeilen, um verschiedene Elemente zur besseren Lesbarkeit zu trennen
  2. Seien Sie konsistent bei Ihren Formatierungsoptionen (verwenden Sie z. B. entweder * oder _ zur Hervorhebung).
  3. Halten Sie es einfach – Markdown ist so konzipiert, dass es als einfacher Text lesbar ist
  4. Testen Sie Ihre Ausgabe, um sicherzustellen, dass sie wie erwartet gerendert wird
  5. Verwenden Sie aussagekräftigen Linktext anstelle allgemeiner Phrasen wie „hier klicken“

Häufige Muster

Verschachtelte Listen 

1. First item
   - Nested item
   - Another nested item
2. Second item
   - More nested content

Listen mit Absätzen 

1. First item

   This is a paragraph under the first item.

2. Second item

   This is a paragraph under the second item.

Blockzitate mit anderen Elementen 

> This is a blockquote with **bold text** and *italic text*.
>
> - It can contain lists
> - And other Markdown elements
>
> > Nested blockquotes are also possible.

Zusammenfassung

Markdown bietet eine einfache, lesbare Möglichkeit, Text zu formatieren und problemlos in HTML umzuwandeln. Halten Sie den Text einfach und lesbar und verwenden Sie die grundlegenden Syntaxelemente konsistent. Mit etwas Übung geht Ihnen Markdown in Fleisch und Blut über und erleichtert das Schreiben strukturierter Inhalte erheblich.

Dieses Tutorial behandelt die Markdown-Kernsyntax aus der ursprünglichen Spezifikation. Erweiterte Funktionen finden Sie in der Dokumentation zu bestimmten Markdown-Prozessoren wie CommonMark (GFM), MultiMarkdown oder GitHub Flavored Markdown.

Next up: Markdown-Dingus ▶

Support Site | Legal | Privacy